Hybris UX Api
POST productOrder
POST (TMF-622)
FOR PR MARKET
This API provides order provisioning resource with operations that allow getting status of order and submitting order provisioning request to and from BSS.
Functionality Scope
1.Only new customer flow is in scope for Installation use case.
2.Telephone (Fixed), Video (TV) and Internet products are in scope.
3.For Telephone only 1Telephone product is in scope.
4.Order can consist of 1P (single product), 2P (two products) and 3P (triple play) in pre-configured set from Hybris, Add on item will be available for internet and Video(TV).
5.If the customer selects an Internet and TV plan in build your own package, telephony is automatically included, and it becomes a 3P Plan.
6.Following are the Products combination in the Scope
| Packages | FTTH | COAX |
|---|---|---|
| 1P Telephone | Y | Y |
| 1P Video/TV | N | Y |
| 1P Internet | Y | Y |
| 2P TV + Internet | Y | Y |
| 2P TV + Phone | N | Y |
| 2P Internet +Phone | Y | Y |
| 3P TV + Phone + Internet | Y | Y |
Key Considerations
1.CSR must ensure that there is no existing customer at the location with order before placing the order, Mulesoft will return error in case it gets warning from SLBOS webservices.
2.Hybris must follow the business rule in selecting the package and applicable addons in the request sent to the Mulesoft layer, There is no validation of the business rule in mulesoft and will act as pass through and provide any error response from SLBOS api in case the execution failed.
3.Price Plan and Offer identifier will be configured as default value in BSS based on package/product code. Hybris won’t be sending any value for these fields.
4.Once the order is submitted from Mulesoft, CSR guy needs to do manual sales signoff, update equipment number.
5.Mulesoft will send the status “Acknowledged” back to SAP Hybris if successfully Order provisioning request is submitted to BSS.
6.In Video/TV Services, Addon will be applicable as per package tier mentioned in catalogue, Premium package can have premium addons, U-pick packages can have u-pick and premium addon, ultimate package can have ultimate and premium addOn.
7.No Add-on for TN (telephone) Services.
8.In case of TechnicianVisit and Self install, Installation charges code will be decided by Hybris/CSR based on customer Credit check and user selection. This should be sent with each request as an AddOnProduct. eg: "0MINS".
9.CallType Product code must be sent with any services with Telephone product.
10.Bill Preference code (paper bill) must be send with each request as an AddOnProducts from Hybris as mandatory addOn.
11.Only one Smart Protect AddOn can be added to product Order.
12.Any Extra STB must be sent along with its installation charge code as an AddOn.
13.Activation Code for the additional STB will depend on TV tier customer have in package.
14.Additional Offer product if applicable must be send as an AddOnProduct, For eg: in 3P package nDVR (Cloud DVR) service product code will be send as an AddOnProduct if the TV Box type is Hub TV
15.Success Response will contain Order ID along with the newly created/existing accountId of the customer.
16.Any Error during execution of underlying BSS Webservice will be passes to Client. Warnings will be captured in the description field.
17.Order should be placed within 14 minutes from tax and fees API call from consumer and it should be controlled from the consumer. Once BSS session is expired, all the steps from tax and fees call should be reprocessed(This limitation is due to 15 mins session validity from BSS). "2099 – DRO30E – REF CDA NOT FOUND" error message is for conversation id expiry.
18.Keep "X-Conversation-Id" in the request to tie the Transactions together.
19.If there is an outage while creating an order in BSS(description contains warning message), Create an order in BSS and update the customer through email. CSR can process the order when the outage is resolved.
20.Campaign, Reason code and Job type are present in the quote API response and possible values mentioned in the table for self install and Technician visit.
21.Add Temporary Order id(id field from quote API response) to externalId in productOrder request
22.Use billingAccount id from the response of create billingAccount in productOrder request(if billing account created before quote API call) else from quote API response.
SelfInstall:
1. Temporary Order id, jobType, conversation id(headers), telephone number(TelephoneNumberId) and billingaccount id from the quote API response(if BillingAccount is not created else use it from create billing account response) should be used in /productOrder call.
2. In case of selfinstall, Order is always created with unscheduled job in BSS. Call Product Order(requestedCompletionDate) API with Unscheduled Job, ie date="4444-12-31T00:00:00.000Z"
TechnicianVisit:
1. Temporary Order id, jobType, conversation id(headers), telephone number(TelephoneNumberId) and billingaccount id(if BillingAccount is not created else use it from create billing account response) from the quote API response should be used in /productOrder call.
2. In case of Slots not available Errors in BSS, description in Quote API response contains Warnings/Error message from BSS(also in /searchTimeSlot response) and based on that, Call Product Order API with Unscheduled Job, ie date="4444-12-31T00:00:00.000Z". In case of any outages, BSS allows order creation in the system despite the outage. CSR can manually update the ORDER with the required job later and notify the customer about the technician visit through email.
3. BSS will block the slot for 4 mins after the searchTimeSlot call, Once it is over, CSG will release the timeslot and it can be Utilized for another customer. Order should be placed within 3 minutes from the searchTimeSlot call considering the API processing time. If all slots are booked, then customer will get error like "2099 | JOB_TYP_TIME_ALRT-J4U22A-ENTERED DT/TM UNAVAIL. We are not getting specific error for Expiry after 4 mins from BSS.
CSR Configurations
Below attributes are provided by SAP Hybris or CSR Person.
1.Installation charges are based on the credit score and user selection will be added by CSR Team in productLineItem as an AddOnProduct.
BaseUriParameter
| Name | Type | M/O | Description |
|---|---|---|---|
| businessId | string | M | Business unit identifier. For LCPR it is ‘PR’ |
Headers
| Name | Type | M/O | Description |
|---|---|---|---|
| client-id | string | M | The client_id identifying the channel. |
| client-secret | string | M | Password associated with the client_id. |
| correlationId | string | M | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layer. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b |
| lob | string | M | This is line of business. Value: “FIXED” |
| channelId | String | M* | Expected Value = ECOM M* = Significance in BSS |
| X-Conversation-Id | string | M only for PR Market | From quote API response headers we get x-conversation-id value. Example: "QAHA017633E52B68CF0000" |
Mandatory Fields for PR Market B2C request:
OrderReasonCode, CampaignCode, JobType, InstallationType, TelephoneNumberId, customerId, requestedCompletionDate, billingAccount.id
Request Body for PR Market productOrder SelfInstall
Note:
Expected values are given below
Self Install
| Campaign | Job Reason | Job Type | Description Job | Install Charge | Description | Charge | Technology |
|---|---|---|---|---|---|---|---|
| SIN | SF | SC | SELF SERV CONNECT | 0MSIN | Current Code | 0.00 | Coax |
| SIN | SF | SC | SELF SERV CONNECT | 0MRIS | Same Day(Not in scope) | 9.99 | Coax |
| SIN | SF | SC | SELF SERV CONNECT | 0MRIN | Next Day(Not in scope) | 4.99 | Coax |
| SIN | SF | CS | FIB-SELF CONNECT | 0MSIN | Current Code | 0.00 | Fiber |
| SIN | SF | CS | FIB-SELF CONNECT | 0MRIS | Same Day(Not in scope) | 9.99 | Fiber |
| SIN | SF | CS | FIB-SELF CONNECT | 0MRIN | Next Day(Not in scope) | 4.99 | Fiber |
| SIN | SF | SS | SELF SERV RESTART | 0MSIN | Current Code | 0.00 | Coax |
| SIN | SF | SS | SELF SERV RESTART | 0MRIS | Same Day(Not in scope) | 9.99 | Coax |
| SIN | SF | SS | SELF SERV RESTART | 0MRIN | Next Day(Not in scope) | 4.99 | Coax |
| SIN | SF | SF | FIB-SELF RESTART | 0MSIN | Current Code | 0.00 | Fiber |
| SIN | SF | SF | FIB-SELF RESTART | 0MRIS | Same Day(Not in scope) | 9.99 | Fiber |
| SIN | SF | SF | FIB-SELF RESTART | 0MRIN | Next Day(Not in scope) | 4.99 | Fiber |
| SIN | SF | US | SELF SERV UPGRADE | 0MSIN | Current Code | 0.00 | Coax |
| SIN | SF | US | SELF SERV UPGRADE | 0MRIS | Same Day(Not in scope) | 9.99 | Coax |
| SIN | SF | US | SELF SERV UPGRADE | 0MRIN | Next Day(Not in scope) | 4.99 | Coax |
| SIN | SF | SU | FIB-SELF UPGRADE | 0MSIN | Current Code | 0.00 | Fiber |
| SIN | SF | SU | FIB-SELF UPGRADE | 0MRIS | Same Day(Not in scope) | 9.99 | Fiber |
| SIN | SF | SU | FIB-SELF UPGRADE | 0MRIN | Next Day(Not in scope) | 4.99 | Fiber |
- For SelfInstall need to pass "InstallationType" = "SelfInstall"
note Subresource in Request
| Name | Type | M/O | Description |
|---|---|---|---|
| OrderReasonCode | M | Reason code for the Package product, Default Value if E1 for technician visit, for self install value is "SF" | { "text": "E1", "@type": "OrderReasonCode"} |
| CampaignCode | M | Campaign code for the BSS order, Default Value if "ECO" for technician visit, for self install value is "SIN" | { "text": "SIN", "@type": "CampaignCode"} |
| CreditLimit | O | PPV Credit limit for the order account, Will be configured by CSR. Default value is 100 | { "text": "100", "@type": "CreditLimit"} |
| JobType | M | Job Type. Possible values are mentioned in the Table for technician visit and self install | { "text": "FN", "@type": "JobType" } |
| TelephoneNumberId | M/O | TelephoneNumberId is mandatory for orders require telephone number. | { "text": "9395455802", "@type": "TelephoneNumberId" } |
| InstallationType | M | Installation type is mandatory to identify the type of Job associated with the Order | { "text": "SelfInstall", "@type": "InstallationType" } |
note Subresource in response
| Name | Type | M/O | Description |
|---|---|---|---|
| OrderReasonCode | String | Y | SF is default value for self install.E1 for TechnicianVisit. Example: { "text": "SF", "@type": "OrderReasonCode" } |
| CampaignCode | String | Y | SIN is default value for self install.ECO for TechnicianVisit. Example: { "text": "SIN", "@type": "CampaignCode" } |
| CreditLimit | String | O | Credit limit. Default value is 100 { "text": "100", "@type": "CreditLimit" } |
| RequestedFunction | String | O | NEW is default value for self install. NEW for TechnicianVisit. Example: { "text": "NEW", "@type": "RequestedFunction" } |
| JobType | String | Y | Possible values are mentioned in the table for self install and Technician Visit. Example: { "text": "FN", "@type": "JobType" } |
| TelephoneNumberId | String | Y | { "text": "9395455802", "@type": "TelephoneNumberId" } |
| InstallationType | String | Y | Based on installation type , order will be processed. possible values are "SelfInstall" / "TechnicianVisit"{ "text": "SelfInstall", "@type": "InstallationType" } |
| JobId | String | Y | { "text": "00000000000054710001", "@type": "JobId" } |
| Technician | String | O | For selfInstall, Technician id will be "3333" { "text": "0701", "@type": "Technician" } |
| JobNumber | String | Y | { "text": "00000", "@type": "JobNumber" } |
Request for SelfInstall
{
"billingAccount": {
"id": "#190150638551501",
"@type": "BillingAccount"
},
"category": "RES",
"externalId": "0000000000002861",
"serviceAddress": {
"addrNo": "00918424400656"
},
"requestedCompletionDate": "4444-12-31T00:00:00.000Z",
"note": [
{
"text": "SF",
"@type": "OrderReasonCode"
},
{
"text": "SIN",
"@type": "CampaignCode"
},
{
"text": "FN",
"@type": "JobType"
},
{
"text": "9395455945",
"@type": "TelephoneNumberId"
},
{
"text": "SelfInstall",
"@type": "InstallationType"
}
],
"productOrderItem":[
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "RV3BC",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "CV"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FJ43X",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FW4US",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FFIPT",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "CV"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FFONT",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "ZY101",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "RZ020",
"quantity": 1,
"action": "add",
"product": {
"id": "RZ020",
"isBundle": false
},
"@type": "AddOnProduct"
},
{
"id": "FRRUS",
"quantity": 1,
"action": "add",
"product": {
"id": "FRRUS",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "CallTypeProduct"
},
{
"id": "0MSIN",
"quantity": 1,
"action": "add",
"product": {
"id": "0MSIN",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
},
{
"id": "ZMPBI",
"quantity": 1,
"action": "add",
"product": {
"id": "ZMPBI",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
}
],
"relatedParty": [
{
"name": "DEV TESTING001",
"role": "Buyer Contact",
"id": "1901506147568",
"@referredType": "Customer"
},
{
"name": "",
"role": "Sales Representative",
"id": "54321",
"@referredType": "SalesRepresentative"
}
],
"@type": "ProductOrder"
}
Response Body for PR Market productOrder SelfInstall
{
"id": "1200047552281013",
"description": "",
"billingAccount": {
"id": "190150638551501",
"@type": "BillingAccount"
},
"state": "Acknowledged",
"category": "RES",
"externalId": "0000000000002861",
"serviceAddress": {
"addrNo": "00918424400656"
},
"requestedCompletionDate": "4444-12-31T00:00:00.000Z",
"note": [
{
"text": "SF",
"@type": "OrderReasonCode"
},
{
"text": "SIN",
"@type": "CampaignCode"
},
{
"text": "NEW",
"@type": "RequestedFunction"
},
{
"text": "100",
"@type": "CreditLimit"
},
{
"text": "SF",
"@type": "JobType"
},
{
"text": "9395455945",
"@type": "TelephoneNumberId"
},
{
"text": "SelfInstall",
"@type": "InstallationType"
},
{
"text": "00000000000028610001",
"@type": "JobId"
},
{
"text": "0710",
"@type": "Technician"
},
{
"text": "00000",
"@type": "JobNumber"
}
],
"productOrderItem": [
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "RV3BC",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "CV"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FJ43X",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FW4US",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FFIPT",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "CV"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "FFONT",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "F7B3I",
"quantity": 1,
"action": "add",
"product": {
"id": "ZY101",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "RZ020",
"quantity": 1,
"action": "add",
"product": {
"id": "RZ020",
"isBundle": false
},
"@type": "AddOnProduct"
},
{
"id": "FRRUS",
"quantity": 1,
"action": "add",
"product": {
"id": "FRRUS",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "CallTypeProduct"
},
{
"id": "0MSIN",
"quantity": 1,
"action": "add",
"product": {
"id": "0MSIN",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
},
{
"id": "ZMPBI",
"quantity": 1,
"action": "add",
"product": {
"id": "ZMPBI",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
}
],
"relatedParty": [
{
"name": "DEV TESTING001",
"role": "Buyer Contact",
"id": "1901506147568",
"@referredType": "Customer"
},
{
"name": "",
"role": "Sales Representative",
"id": "54321",
"@referredType": "SalesRepresentative"
}
],
"@type": "ProductOrder"
}
Possible JobType Values
| CTD 32 Values(2Digit) | Description |
|---|---|
| AO | A/O UPGRADE |
| AU | AUDIT |
| BD | NW/BURY/DROP |
| BN | B2B SELF CONNECT |
| BR | B2B SELF RESTART |
| BT | BUCKET TRUCK |
| BU | B2B SELF UPGRADE |
| CP | CONSTRUCTN/PREWIRE |
| CS | FIB-SELF CONNECT |
| DH | HSD DOWNGRADE |
| DN | DOWNGRADE |
| EP | EQUIPMENT PICKUP |
| FC | FIBER SERVICE CHG |
| FM | FIBER MIGRATION |
| FN | FTTH INSTALL |
| FS | FIBER RESTART |
| GA | GUINDOLA |
| HC | HSD RECONNECT |
| HN | HSD NEW CONNECT |
| HR | HSD RESTART |
| IT | INST TROUBLE CALL |
| KC | COMM-RECONNECT |
| KN | COMM-NEW CONNECT |
| KR | COMM-RESTART |
| KS | BSB F-SELF RESTART |
| KU | COMM-UPG |
| MN | INTER ESCALATION |
| MR | MAINTENANCE\REPAIR |
| NC | NEW CONNECT |
| NK | BSB F-SELF CONNECT |
| NP | NONPAY |
| OL | FAT NO OPT LIGHT |
| PS | PEND CONSTRUCTION |
| RC | RECOONECTS |
| RP | REPLACE DROP |
| RS | RESTART SERVICE |
| RT | RETRENCH\TRENCH |
| SC | SELF SERV CONNECT |
| SF | FIB-SELF RESTART |
| SH | SIDEGRADE |
| SP | CERTIFIED NODE |
| SR | SYSTEM REPLACEMENT |
| SS | SELF SERV RESTART |
| SU | FIB-SELF UPGRADE |
| TA | TROUBLE CALL |
| TB | BS-TROUBLE CALL |
| TE | TAP&EQUIP DISCO |
| TF | FTTH TROUBLE CALL |
| TN | TELE NEW CONNECT |
| TP | TP DISCO |
| TR | TELE RESTART |
| UH | HSD UPGARDE |
| UK | B2B F-SELFUPGRADE |
| UP | UPGRADE |
| US | SELF SERV UPGRADE |
| UT | TELE UPGRADE |
| VD | VOLUNTARY DISCO |
| VS | VERIFY SERVICE |
| VT | TRANSFER |
Request Body for PR Market productOrder TechnicianVisit
Note:
Expected values for Installation scope are given below
| Campaign | Reason | Job Type | Description Job | Technology |
|---|---|---|---|---|
| ECO | E1 | FN | FTTH INSTALL | Fiber |
| ECO | E1 | FS | FIBER RESTART | Fiber |
| ECO | E1 | FC | FIBER SERVICE CHG | Fiber |
| ECO | E1 | HC | HSD RECONNECT | Coax |
| ECO | E1 | HN | HSD NEW CONNECT | Coax |
| ECO | E1 | HR | HSD RESTART | Coax |
| ECO | E1 | UH | HSD UPGRADE | Coax |
| ECO | E1 | NC | NEW CONNECT | Coax |
| ECO | E1 | RC | RECONNECTS | Coax |
| ECO | E1 | RS | RESTART SERVICE | Coax |
| ECO | E1 | DN | DOWNGRADE | Coax |
| ECO | E1 | UP | UPGRADE | Coax |
1.For TechnicianVisit need to pass "InstallationType" = "TechnicianVisit".
2.requestedQuoteCompletionDate should be based on customer selection(/searchTimeSlot).
3. "TelephoneNumberId" pick from Tax and Fees (quote) response.
{
"billingAccount": {
"id": "#190150614889701",
"@type": "BillingAccount"
},
"category": "RES",
"externalId": "0000000000000981",
"serviceAddress": {
"addrNo": "00918424400185"
},
"requestedCompletionDate": "2023-01-11T12:45:12.028Z",
"note": [
{
"text": "E1",
"@type": "OrderReasonCode"
},
{
"text": "ECO",
"@type": "CampaignCode"
},
{
"text": "FN",
"@type": "JobType"
},
{
"text": "9395455900",
"@type": "TelephoneNumberId"
},
{
"text": "TechnicianVisit",
"@type": "InstallationType"
}
],
"productOrderItem": [
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "RJ43X",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "RW4US",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "RF6CB",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "ZD107",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "ZD10N",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "ZY102",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "RRRUS",
"quantity": 1,
"action": "add",
"product": {
"id": "RRRUS",
"isBundle": false,
"@type": "Product"
},
"@type": "CallTypeProduct"
},
{
"id": "ZMPBI",
"quantity": 1,
"action": "add",
"product": {
"id": "ZMPBI",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
},
{
"id": "0MINS",
"quantity": 1,
"action": "add",
"product": {
"id": "0MINS",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
}
],
"relatedParty": [
{
"name": "DEV TESTING001",
"role": "Buyer Contact",
"id": "1901506148897",
"@referredType": "Customer"
},
{
"name": "",
"role": "Sales Representative",
"id": "54321",
"@referredType": "SalesRepresentative"
}
],
"@type": "ProductOrder"
}Response Body for PR Market productOrder TechnicianVisit
{
"id": "1200047553421014",
"description": "",
"billingAccount": {
"id": "190150614889701",
"@type": "BillingAccount"
},
"state": "Acknowledged",
"category": "RES",
"externalId": "0000000000000981",
"serviceAddress": {
"addrNo": "00918424400185"
},
"requestedCompletionDate": "2023-01-11T12:45:12.028Z",
"note": [
{
"text": "E1",
"@type": "OrderReasonCode"
},
{
"text": "ECO",
"@type": "CampaignCode"
},
{
"text": "NEW",
"@type": "RequestedFunction"
},
{
"text": "100.00",
"@type": "CreditLimit"
},
{
"text": "FN",
"@type": "JobType"
},
{
"text": "9395455900",
"@type": "TelephoneNumberId"
},
{
"text": "TechnicianVisit",
"@type": "InstallationType"
},
{
"text": "00000000000009810001",
"@type": "JobId"
},
{
"text": "0710",
"@type": "Technician"
},
{
"text": "0000",
"@type": "JobNumber"
}
],
"productOrderItem": [
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "RJ43X",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "RW4US",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "RF6CB",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "ZD107",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "ZD10N",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "ZY102",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "RRRUS",
"quantity": 1,
"action": "add",
"product": {
"id": "RRRUS",
"isBundle": false,
"@type": "Product"
},
"@type": "CallTypeProduct"
},
{
"id": "ZMPBI",
"quantity": 1,
"action": "add",
"product": {
"id": "ZMPBI",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
},
{
"id": "0MINS",
"quantity": 1,
"action": "add",
"product": {
"id": "0MINS",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
}
],
"relatedParty": [
{
"name": "DEV TESTING001",
"role": "Buyer Contact",
"id": "1901506148897",
"@referredType": "Customer"
},
{
"name": "",
"role": "Sales Representative",
"id": "54321",
"@referredType": "SalesRepresentative"
}
],
"@type": "ProductOrder"
}
Possible warnings cases for Description
**Existing customer**:
"description": "ORV59I - EXISTING CUSTOMER AT LOCATION",
**Outage**:
"description": "8211990010051704OTG REASN - AA AUTO OUTAGE DECLARED 13:24 01/02/23",
**NO DATES AVAILABLE FOR THIS JOB/JOB_UNSCHED_ALRT**:
"description": "JOB_UNSCHED_ALRT,JBE74A-ENTER OVERRIDE TO UNSCHEDULE JOB,ADP10E-NO DATES AVAILABLE FOR THIS JOB"Error Scenarios
When we provide the expired X-Conversation-Id
{
"errors": [
{
"code": 400,
"message": "Error Occurred during order provisioning UPDATEORDERDETAIL:ERROROCCURED",
"description": "2099 | DRO30E - REF CDA NOT FOUND| "
}
]
}
When order got SignOff
{
"errors": [
{
"code": 400,
"message": "Error Occurred during order provisioning UPDATEORDERDETAIL:ERROROCCURED",
"description": "2099 | SERV_CD-MAP15E - FIELD PROTECTED, CANNOT UPDATE| "
}
]
}
On the currentDay, if no slots are available
{
"errors": [
{
"code": 400,
"message": "Error Occurred during order provisioning UPDATEORDERDETAIL:ERROROCCURED",
"description": "2099 | SCHED_TM-JBE10E-INVALID SCHEDULED TIME OF DAY| "
}
]
}
Request Body for PR TechnicianVisit(unscheduled order)
"category": "RES",
"externalId": "0000000000007101",
{
"billingAccount": {
"id": "8211990010051704",
"@type": "BillingAccount"
},
"serviceAddress": {
"addrNo": "00918424400185"
},
"requestedCompletionDate": "4444-12-31T00:00:00.000Z",
"note": [
{
"text": "E1",
"@type": "OrderReasonCode"
},
{
"text": "ECO",
"@type": "CampaignCode"
},
{
"text": "FS",
"@type": "JobType"
},
{
"text": "9395455946",
"@type": "TelephoneNumberId"
},
{
"text": "TechnicianVisit",
"@type": "InstallationType"
}
],
"productOrderItem": [
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "RJ43X",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "RW4US",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "RF6CB",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "ZD107",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "ZD10N",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "ZY102",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "RRRUS",
"quantity": 1,
"action": "add",
"product": {
"id": "RRRUS",
"isBundle": false,
"@type": "Product"
},
"@type": "CallTypeProduct"
},
{
"id": "ZMPBI",
"quantity": 1,
"action": "add",
"product": {
"id": "ZMPBI",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
},
{
"id": "0MINS",
"quantity": 1,
"action": "add",
"product": {
"id": "0MINS",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
}
],
"relatedParty": [
{
"name": "DEV TESTING001",
"role": "Buyer Contact",
"id": "1901506139847",
"@referredType": "Customer"
},
{
"name": "",
"role": "Sales Representative",
"id": "54321",
"@referredType": "SalesRepresentative"
}
],
"@type": "ProductOrder"
}Request Body for JM Liberate
{
"category": "R",
"billingAccount": {
"id": "100015870000"
},
"orderCharacteristics": {
"cisEmpId": "99999",
"depttCode": "AQSAL",
"siteCode": "ANSQ",
"sourceOfApplication": "3",
"salesRepId": "99999",
"carrierUniqueServId": "0",
"lastLineNumber": "last line number of order",
"exchangeId": "FLTV",
"numberAreaCode": "BODG"
},
"serviceAddress": {
"addrNo": "",
"addrType": "A",
"addrLine1": "Street no",
"addrLine2": "road",
"addrLine3": "TROPICAL PLAZA",
"addrLine4": "KINGSTON",
"addrLine5": "Jamaica",
"addrPostCode": "00000"
},
"productOrderItem": [
{
"id": "609002_RES",
"quantity": 1,
"action": "add",
"product": {
"isBundle": true
}
}
]
}
Request Body for JM Cerillion
{
"category": "R",
"billingAccount": {
"id": "100015870000"
},
"orderCharacteristics": {
"cisEmpId": "99999",
"depttCode": "AQSAL",
"siteCode": "ANSQ",
"sourceOfApplication": "3",
"salesRepId": "99999",
"carrierUniqueServId": "0",
"lastLineNumber": "last line number of order",
"exchangeId": "FLTV",
"numberAreaCode": "BODG"
},
"serviceAddress": {
"addrNo": "",
"addrType": "A",
"addrLine1": "Street no",
"addrLine2": "road",
"addrLine3": "TROPICAL PLAZA",
"addrLine4": "KINGSTON",
"addrLine5": "Jamaica",
"addrPostCode": "00000"
},
"productOrderItem": [
{
"id": "RSPBDESS",
"quantity": 1,
"action": "add",
"product": {
"isBundle": true,
"productCharacteristic": [
{
"name": "discountGroupCode",
"valueType": "string",
"value": "B2BI2"
}
]
}
}
]
}Response Body for PR TechnicianVisit(unscheduled order)
{
"id": "1200048006601012",
"description":"",
"billingAccount": {
"id": "8211990010051712",
"@type": "BillingAccount"
},
"note": [
{
"text": "E1",
"@type": "OrderReasonCode"
},
{
"text": "ECO",
"@type": "CampaignCode"
},
{
"text": "click to call",
"@type": "JobComment"
},
{
"text": "NEW",
"@type": "RequestedFunction"
},
{
"text": "100.00",
"@type": "CreditLimit"
},
{
"text": "FN",
"@type": "JobType"
},
{
"text": "9395455900",
"@type": "TelephoneNumberId"
},
{
"text": "TechnicianVisit",
"@type": "installationType"
},
{
"text": "12000480066010120001",
"@type": "JobId"
},
{
"text": "0701",
"@type": "Technician"
},
{
"text": "111390",
"@type": "JobNumber"
}
],
"state": "Acknowledged",
"category": "RES",
"externalId": "0000000000008031",
"orderCharacteristics": {
"salesRepId": "54321"
},
"serviceAddress": {
"addrNo": "00918424400193"
},
"requestedCompletionDate": "4444-12-31T00:00:00.000Z",
"productOrderItem": [
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "RJ43X",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "RW4US",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "RF6CB",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "ZD107",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "ZD10N",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "TD"
}
]
},
"@type": "Package"
},
{
"id": "R6430",
"quantity": 1,
"action": "add",
"product": {
"id": "ZY102",
"isBundle": true,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "HS"
}
]
},
"@type": "Package"
},
{
"id": "RRRUS",
"quantity": 1,
"action": "add",
"product": {
"id": "RRRUS",
"isBundle": false,
"@type": "Product"
},
"@type": "CallTypeProduct"
},
{
"id": "ZMPBI",
"quantity": 1,
"action": "add",
"product": {
"id": "ZMPBI",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
},
{
"id": "0MINS",
"quantity": 1,
"action": "add",
"product": {
"id": "0MINS",
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "ServiceType",
"valueType": "string",
"value": "NU"
}
]
},
"@type": "AddOnProduct"
}
],
"relatedParty": [{
"id": "1101521625538",
"name": "Maria Ulawoo",
"@referredType": "Customer"
}
],
"@type": "ProductOrder"
}Response for PA
{
"billingAccount":{
"id": "324063130000"
},
"orderCharacteristics":
{
"cisEmpId":"99999",
"depttCode":"TIEN",
"siteCode":"FTTH",
"sourceOfApplication":"EH",
"salesRepId":"70013",
"carrierUniqueServId":"0",
"lastLineNumber":"last line number of order",
"exchangeId_TP": "POGP",
"numberAreaCode_TP": "POBS",
"exchangeId_DS": "POGP",
"numberAreaCode_DS": "POBS",
"exchangeId_TI": "PFLO",
"numberAreaCode_TI": "FPME",
"exchangeId_MO": "PSC",
"numberAreaCode_MO": "CDEM"
},
"serviceAddress":
{
"addrType":"Q",
"addrLine1":"casa A159",
"addrLine2":"Calle Santo Tom",
"addrLine3":"CIUDA SAN LORENZO",
"addrLine4":"LAS CUMBRES",
"addrLine5":"PANAMA"
},
"productOrderItem":[
{
"id":"2P600LF",
"quantity":1,
"action":"add",
"product":{
"isBundle":true,
"@type":"Bundle"
},
"@type":"ProductOrderItem"
}
],
"@type":"ProductOrder"
}Response for PA
{
"id": "FL0070H",
"state": null,
"billingAccount": {
"id": "324063130000"
},
"orderCharacteristics": {
"cisEmpId": "99999",
"depttCode": "TIEN",
"siteCode": "FTTH",
"sourceOfApplication": "EH",
"salesRepId": "70013",
"carrierUniqueServId": "0",
"lastLineNumber": "last line number of order",
"exchangeId_TP": "POGP",
"numberAreaCode_TP": "POBS",
"exchangeId_DS": "POGP",
"numberAreaCode_DS": "POBS",
"exchangeId_TI": "PFLO",
"numberAreaCode_TI": "FPME",
"exchangeId_MO": "PSC",
"numberAreaCode_MO": "CDEM"
},
"serviceAddress": {
"addrType": "Q",
"addrLine1": "casa A159",
"addrLine2": "Calle Santo Tom",
"addrLine3": "CIUDA SAN LORENZO",
"addrLine4": "LAS CUMBRES",
"addrLine5": "PANAMA"
},
"productOrderItem": [
{
"id": "2P600LF",
"quantity": 1,
"action": "add",
"product": {
"isBundle": true,
"@type": "Bundle"
},
"@type": "ProductOrderItem"
}
],
"@type": "ProductOrder"
}Response Body for JM Liberate
{
"id": "DJ0001H",
"category": "R",
"description": "Product Order illustration sample",
"billingAccount": {
"id": "100015870000"
},
"orderCharacteristics": {
"cisEmpId": "99999",
"depttCode": "AQSAL",
"siteCode": "ANSQ",
"sourceOfApplication": "3",
"salesRepId": "99999",
"carrierUniqueServId": "0",
"lastLineNumber": "last line number of order",
"exchangeId": "FLTV",
"numberAreaCode": "BODG"
},
"serviceAddress": {
"addrNo": "1234",
"addrType": "A",
"addrLine1": "service address line 1",
"addrLine2": "service address line 2",
"addrLine3": "service address line 3",
"addrLine4": "service address line 4",
"addrLine5": "service address line 5",
"addrPostCode": "00000"
},
"productOrderItem": [
{
"id": "VDC",
"quantity": 1,
"action": "add",
"product": {
"isBundle": true,
"@type": "Product"
},
"@type": "ProductOrderItem"
}
],
"@type": "ProductOrder"
}Response Body for JM Cerillion
{
"id": 4730301,
"category": "R",
"description": "Product Order illustration sample",
"billingAccount": {
"id": "91000526"
},
"orderCharacteristics": {
"cisEmpId": "99999",
"depttCode": "AQSAL",
"siteCode": "ANSQ",
"sourceOfApplication": "3",
"salesRepId": "99999",
"carrierUniqueServId": "0",
"lastLineNumber": "last line number of order",
"exchangeId": "FLTV",
"numberAreaCode": "BODG"
},
"serviceAddress": {
"addrNo": "819241",
"addrType": "A",
"addrLine1": "",
"addrLine2": "CONSTANT SPRING ROAD",
"addrLine3": "SHOP 9 TROPICAL PLAZA",
"addrLine4": "KINGSTON",
"addrLine5": "Jamaica",
"addrPostCode": "00000"
},
"priority": null,
"requestedCompletionDate": null,
"requestedStartDate": null,
"productOrderItem": [
{
"id": "RSPTHPBF",
"quantity": 1,
"action": "add",
"product": {
"isBundle": true
}
}
],
"state": "Acknowledged"
}